.TH "include/ccn/keystore.h" 3 "14 Sep 2011" "Version 0.4.1" "Content-Centric Networking in C" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/ccn/keystore.h \- KEYSTORE interface. 
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "struct ccn_keystore * \fBccn_keystore_create\fP (void)"
.br
.ti -1c
.RI "void \fBccn_keystore_destroy\fP (struct ccn_keystore **p)"
.br
.ti -1c
.RI "int \fBccn_keystore_init\fP (struct ccn_keystore *p, char *name, char *password)"
.br
.ti -1c
.RI "struct ccn_pkey * \fBccn_keystore_private_key\fP (struct ccn_keystore *p)"
.br
.ti -1c
.RI "struct ccn_pkey * \fBccn_keystore_public_key\fP (struct ccn_keystore *p)"
.br
.ti -1c
.RI "ssize_t \fBccn_keystore_public_key_digest_length\fP (struct ccn_keystore *p)"
.br
.ti -1c
.RI "const unsigned char * \fBccn_keystore_public_key_digest\fP (struct ccn_keystore *p)"
.br
.ti -1c
.RI "struct ccn_certificate * \fBccn_keystore_certificate\fP (struct ccn_keystore *p)"
.br
.ti -1c
.RI "int \fBccn_keystore_file_init\fP (char *filename, char *password, char *subject, int keylength, int validity_days)"
.br
.RI "\fICreate a PKCS12 keystore file. \fP"
.in -1c
.SH "Detailed Description"
.PP 
KEYSTORE interface. 

This is a veneer so that the ccn code can avoid exposure to the underlying keystore implementation types.
.PP
Part of the CCNx C Library.
.PP
Copyright (C) 2009 Palo Alto Research Center, Inc.
.PP
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
.PP
Definition in file \fBkeystore.h\fP.
.SH "Function Documentation"
.PP 
.SS "struct ccn_certificate* ccn_keystore_certificate (struct ccn_keystore * p)\fC [read]\fP"
.PP
Definition at line 130 of file ccn_keystore.c.
.SS "struct ccn_keystore* ccn_keystore_create (void)\fC [read]\fP"
.PP
Definition at line 44 of file ccn_keystore.c.
.PP
Referenced by ccn_load_private_key(), and main().
.SS "void ccn_keystore_destroy (struct ccn_keystore ** p)"
.PP
Definition at line 51 of file ccn_keystore.c.
.PP
Referenced by ccn_load_private_key(), finalize_keystore(), and main().
.SS "int ccn_keystore_file_init (char * filename, char * password, char * subject, int keylength, int validity_days)"
.PP
Create a PKCS12 keystore file. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the name of the keystore file to be created. 
.br
\fIpassword\fP the import/export password for the keystore. 
.br
\fIsubject\fP the subject (and issuer) name in the certificate. A lowercase version of the subject name will be used for the 'friendly name' (alias) associated with the private key. 
.br
\fIkeylength\fP the number of bits in the RSA key to be generated. A value <= 0 will result in the default (1024) being used. 
.br
\fIvalidity_days\fP the number of days the certificate in the keystore will be valid. A value <= 0 will result in the default (30) being used. 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on failure 
.RE
.PP

.PP
Definition at line 179 of file ccn_keystore.c.
.PP
Referenced by ccnd_init_internal_keystore().
.SS "int ccn_keystore_init (struct ccn_keystore * p, char * name, char * password)"
.PP
Definition at line 66 of file ccn_keystore.c.
.PP
Referenced by ccn_load_private_key(), and main().
.SS "struct ccn_pkey* ccn_keystore_private_key (struct ccn_keystore * p)\fC [read]\fP"
.PP
Definition at line 98 of file ccn_keystore.c.
.PP
Referenced by ccn_sign_content(), and main().
.SS "struct ccn_pkey* ccn_keystore_public_key (struct ccn_keystore * p)\fC [read]\fP"
.PP
Definition at line 107 of file ccn_keystore.c.
.PP
Referenced by ccn_get_public_key(), ccn_sign_content(), and main().
.SS "const unsigned char* ccn_keystore_public_key_digest (struct ccn_keystore * p)"
.PP
Definition at line 122 of file ccn_keystore.c.
.PP
Referenced by ccn_get_public_key(), ccn_load_private_key(), ccn_sign_content(), and main().
.SS "ssize_t ccn_keystore_public_key_digest_length (struct ccn_keystore * p)"
.PP
Definition at line 116 of file ccn_keystore.c.
.PP
Referenced by ccn_get_public_key(), ccn_load_private_key(), ccn_sign_content(), and main().
.SH "Author"
.PP 
Generated automatically by Doxygen for Content-Centric Networking in C from the source code.
